STATFS

Section: System Calls (2)
Index Return to Main Contents

BSD mandoc

NAME

statfs - get file system statistics

SYNOPSIS

Fd #include <sys/param.h> Fd #include <sys/mount.h> Ft int Fn statfs const char *path struct statfs *buf Ft int Fn fstatfs int fd struct statfs *buf

DESCRIPTION

Fn Statfs returns information about a mounted file system. Fa Path is the path name of any file within the mounted file system. Fa Buf is a pointer to a Fn statfs structure defined as follows:

typedef struct { int32_t val[2]; } fsid_t;

#define MFSNAMELEN   16 /* length of fs type name, including nul */
#define MNAMELEN     32 /* length of buffer for returned name */

struct statfs {
    short   f_type;     /* type of file system (unused; zero) */
    short   f_flags;    /* copy of mount flags */
    long    f_bsize;    /* fundamental file system block size */
    long    f_iosize;   /* optimal transfer block size */
    long    f_blocks;   /* total data blocks in file system */
    long    f_bfree;    /* free blocks in fs */
    long    f_bavail;   /* free blocks avail to non-superuser */
    long    f_files;    /* total file nodes in file system */
    long    f_ffree;    /* free file nodes in fs */
    fsid_t  f_fsid;     /* file system id */
    uid_t   f_owner;    /* user that mounted the file system */
    long    f_spare[4]; /* spare for later */
    char    f_fstypename[MFSNAMELEN]; /* fs type name */
    char    f_mntonname[MNAMELEN];    /* directory on which mounted */
    char    f_mntfromname[MNAMELEN];  /* mounted file system */
};

Fields that are undefined for a particular file system are set to -1. Fn Fstatfs returns the same information about an open file referenced by descriptor Fa fd .

RETURN VALUES

Upon successful completion, a value of 0 is returned. Otherwise, -1 is returned and the global variable errno is set to indicate the error.

ERRORS

Fn Statfs fails if one or more of the following are true:

Bq Er ENOTDIR: A component of the path prefix of Fa Path is not a directory.
Bq Er ENAMETOOLONG: The length of a component of Fa path exceeds {NAME_MAX} characters, or the length of Fa path exceeds {PATH_MAX} characters.
Bq Er ENOENT: The file referred to by Fa path does not exist.
Bq Er EACCES: Search permission is denied for a component of the path prefix of Fa path .
Bq Er ELOOP: Too many symbolic links were encountered in translating Fa path .
Bq Er EFAULT: Fa Buf or Fa path points to an invalid address.
Bq Er EIO: An I/O error occurred while reading from or writing to the file system.

Fn Fstatfs fails if one or more of the following are true:

Bq Er EBADF: Fa Fd is not a valid open file descriptor.
Bq Er EFAULT: Fa Buf points to an invalid address.
Bq Er EIO: An I/O error occurred while reading from or writing to the file system.

HISTORY

The Fn statfs function first appeared in 4.4BSD.

This document was created by man2html, using the manual pages.
Time: 19:41:55 GMT, December 25, 2022